home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / NDK / NDK_3.5 / Include / include_i / libraries / amigaguide.i < prev    next >
Encoding:
Text File  |  1999-10-20  |  7.5 KB  |  249 lines
  1.     IFND LIBRARIES_AMIGAGUIDE_I
  2. LIBRARIES_AMIGAGUIDE_I    SET    1
  3. **
  4. **    $VER: amigaguide.i 44.1 (14.3.1999)
  5. **    Includes Release 44.1
  6. **
  7. **    Interface definitions for AmigaGuide(tm) hypertext system
  8. **
  9. **    Copyright © 1990-1999 Amiga, Inc.
  10. **        All Rights Reserved
  11. **
  12.  
  13. ;------------------------------------------------------------------------------
  14.  
  15.     IFND EXEC_TYPES_I
  16.     INCLUDE "exec/types.i"
  17.     ENDC ;* EXEC_TYPES_I
  18.  
  19.     IFND EXEC_LISTS_I
  20.     INCLUDE "exec/lists.i"
  21.     ENDC ;* EXEC_LISTS_I
  22.  
  23.     IFND EXEC_NODES_I
  24.     INCLUDE "exec/nodes.i"
  25.     ENDC ;* EXEC_NODES_I
  26.  
  27.     IFND EXEC_SEMAPHORES_I
  28.     INCLUDE "exec/semaphores.i"
  29.     ENDC
  30.  
  31.     IFND INTUITION_INTUITION_I
  32.     INCLUDE "intuition/intuition.i"
  33.     ENDC
  34.  
  35.     IFND INTUITION_SCREENS_I
  36.     INCLUDE "intuition/screens.i"
  37.     ENDC
  38.  
  39.     IFND DO_DOS_I
  40.     INCLUDE "dos/dos.i"
  41.     ENDC
  42.  
  43.     IFND UTILITY_TAGITEM_I
  44.     INCLUDE "utility/tagitem.i"
  45.     ENDC
  46.  
  47.     IFND UTILITY_HOOKS_I
  48.     INCLUDE "utility/hooks.i"
  49.     ENDC
  50.  
  51. ;------------------------------------------------------------------------------
  52.  
  53.     IFND APSH_TOOL_ID
  54. APSH_TOOL_ID        equ    11000
  55. StartupMsgID        equ    (APSH_TOOL_ID+1)    ; Startup message
  56. LoginToolID        equ    (APSH_TOOL_ID+2)    ; Login a tool SIPC port
  57. LogoutToolID        equ    (APSH_TOOL_ID+3)    ; Logout a tool SIPC port
  58. ShutdownMsgID        equ    (APSH_TOOL_ID+4)    ; Shutdown message
  59. ActivateToolID        equ    (APSH_TOOL_ID+5)    ; Activate tool
  60. DeactivateToolID    equ    (APSH_TOOL_ID+6)    ; Deactivate tool
  61. ActiveToolID        equ    (APSH_TOOL_ID+7)    ; Tool Active
  62. InactiveToolID        equ    (APSH_TOOL_ID+8)    ; Tool Inactive
  63. ToolStatusID        equ    (APSH_TOOL_ID+9)    ; Status message
  64. ToolCmdID        equ    (APSH_TOOL_ID+10)    ; Tool command message
  65. ToolCmdReplyID        equ    (APSH_TOOL_ID+11)    ; Reply to tool command
  66. ShutdownToolID        equ    (APSH_TOOL_ID+12)    ; Shutdown tool
  67.     ENDC
  68.  
  69. ;------------------------------------------------------------------------------
  70.  
  71. ; Attributes accepted by GetAmigaGuideAttr()
  72. AGA_Dummy        equ    (TAG_USER)
  73. AGA_Path        equ    (AGA_Dummy+1)
  74. AGA_XRefList        equ    (AGA_Dummy+2)
  75. AGA_Activate        equ    (AGA_Dummy+3)
  76. AGA_Context        equ    (AGA_Dummy+4)
  77.  
  78. AGA_HelpGroup        equ    (AGA_Dummy+5)
  79.     ; (ULONG) unique window identifier
  80.  
  81. AGA_ARexxPort        equ    (AGA_Dummy+9)
  82.     ; (struct MsgPort *) Pointer to the ARexx message port (V40)
  83.  
  84. AGA_ARexxPortName    equ    (AGA_Dummy+10)
  85.    ; (STRPTR) Used to specify the ARexx port name (V40) (not copied)
  86.  
  87. AGA_Secure        equ    (AGA_Dummy+11)
  88.    ; (BOOL) Disable "ONOPEN", "ONCLOSE" and "LINK RX", "LINK RXS", "LINK SYSTEM" commands (V41)
  89.  
  90. ;------------------------------------------------------------------------------
  91.  
  92.     STRUCTURE AmigaGuideMsg,0
  93.     STRUCT        agm_Msg,MN_SIZE            ; Embedded Exec message structure
  94.     ULONG        agm_Type;            ; Type of message
  95.     APTR        agm_Data;            ; Pointer to message data
  96.     ULONG        agm_DSize;            ; Size of message data
  97.     ULONG        agm_DType;            ; Type of message data
  98.     ULONG        agm_Pri_Ret;            ; Primary return value
  99.     ULONG        agm_Sec_Ret;            ; Secondary return value
  100.     APTR        agm_System1;
  101.     APTR        agm_System2;
  102.     LABEL AmigaGuideMsg_SIZEOF
  103.  
  104. ;------------------------------------------------------------------------------
  105.  
  106. ; Allocation description structure
  107.     STRUCTURE NewAmigaGuide,0
  108.     BPTR        nag_Lock            ; Lock on the document directory
  109.     APTR        nag_Name            ; Name of document file
  110.     APTR        nag_Screen            ; Screen to place windows within
  111.     APTR        nag_PubScreen            ; Public screen name to open on
  112.     APTR        nag_HostPort            ; Application's ARexx port name
  113.     APTR        nag_ClientPort            ; Name to assign to the clients ARexx port
  114.     APTR        nag_BaseName            ; Base name of the application
  115.     ULONG        nag_Flags            ; Flags
  116.     APTR        nag_Context            ; NULL terminated context table
  117.     APTR        nag_Node            ; Node to align on first (defaults to Main)
  118.     LONG        nag_Line            ; Line to align on
  119.     APTR        nag_Extens            ; Tag array extens
  120.     APTR        nag_Client            ; Private! MUST be NULL
  121.     LABEL NewAmigaGuide_SIZEOF
  122.  
  123. ; nag_Flags
  124.     BITDEF HT,LOAD_INDEX,0                ; Force load the index at init time
  125.     BITDEF HT,LOAD_ALL,1                ; Force load the entire database at init
  126.     BITDEF HT,CACHE_NODE,2                ; Cache each node as visited
  127.     BITDEF HT,CACHE_DB,3                ; Keep the buffers around until expunge
  128.     BITDEF HT,UNIQUE,4                    ; Unique ARexx port name
  129.     BITDEF HT,NOACTIVATE,5                ; Don't activate window
  130.  
  131. ;------------------------------------------------------------------------------
  132.  
  133. HTFC_SYSGADS        equ    $80000000
  134.  
  135. ;------------------------------------------------------------------------------
  136.  
  137. ; Callback function ID's
  138. HTH_OPEN        equ    0
  139. HTH_CLOSE        equ    1
  140.  
  141. ;------------------------------------------------------------------------------
  142.  
  143. ; Error message ID's
  144. HTERR_NOT_ENOUGH_MEMORY        equ    100
  145. HTERR_CANT_OPEN_DATABASE    equ    101
  146. HTERR_CANT_FIND_NODE        equ    102
  147. HTERR_CANT_OPEN_NODE        equ    103
  148. HTERR_CANT_OPEN_WINDOW        equ    104
  149. HTERR_INVALID_COMMAND        equ    105
  150. HTERR_CANT_COMPLETE        equ    106
  151. HTERR_PORT_CLOSED        equ    107
  152. HTERR_CANT_CREATE_PORT        equ    108
  153. HTERR_KEYWORD_NOT_FOUND        equ    113
  154.  
  155. ;------------------------------------------------------------------------------
  156.  
  157. ; Cross reference node
  158.     STRUCTURE XRef,0
  159.     STRUCT        xr_Node,LN_SIZE            ; Embedded node
  160.     UWORD        xr_Pad                ; Padding
  161.     APTR        xr_DF                ; Document defined in (not used)
  162.     APTR        xr_File                ; Name of document file
  163.     APTR        xr_Name                ; Name of item
  164.     LONG        xr_Line                ; Line defined at
  165.     LABEL XRef_SIZEOF
  166.  
  167. ;------------------------------------------------------------------------------
  168.  
  169. ; Types of cross reference nodes
  170. XR_GENERIC    equ    0
  171. XR_FUNCTION    equ    1
  172. XR_COMMAND    equ    2
  173. XR_INCLUDE    equ    3
  174. XR_MACRO    equ    4
  175. XR_STRUCT    equ    5
  176. XR_FIELD    equ    6
  177. XR_TYPEDEF    equ    7
  178. XR_DEFINE    equ    8
  179.  
  180. ;------------------------------------------------------------------------------
  181.  
  182. ; Callback handle
  183.     STRUCTURE AmigaGuideHost,0
  184.     STRUCT        agh_Dispatcher,h_SIZEOF        ; Dispatcher
  185.     ULONG        agh_Reserved            ; Must be 0
  186.     ULONG        agh_Flags            ; Control flags
  187.     ULONG        agh_UseCnt            ; Number of open nodes
  188.     APTR        agh_SystemData            ; Reserved for system use
  189.     APTR        agh_UserData            ; Application use
  190.     LABEL AmigaGuideHost_SIZEOF
  191.  
  192. ;------------------------------------------------------------------------------
  193.  
  194. ; Methods
  195. HM_FINDNODE    equ    1
  196. HM_OPENNODE    equ    2
  197. HM_CLOSENODE    equ    3
  198. HM_EXPUNGE    equ    10                ; Expunge DataBase
  199.  
  200.  
  201. ;------------------------------------------------------------------------------
  202.  
  203. ; HM_FINDNODE
  204.     STRUCTURE opFindHost,0
  205.     ; ULONG        MethodID
  206.     APTR        ofh_Attrs            ; R: Additional attributes
  207.     APTR        ofh_Node            ; R: Name of node
  208.     APTR        ofh_TOC                ; W: Table of Contents
  209.     APTR        ofh_Title            ; W: Title to give to the node
  210.     APTR        ofh_Next            ; W: Next node to browse to
  211.     APTR        ofh_Prev            ; W: Previous node to browse to
  212.  
  213. ;------------------------------------------------------------------------------
  214.  
  215. ; HM_OPENNODE, HM_CLOSENODE
  216.     STRUCTURE opNodeIO,0
  217.     ; ULONG        MethodID
  218.     APTR        onm_Attrs            ; R: Additional attributes
  219.     APTR        onm_Node            ; R: Node name and arguments
  220.     APTR        onm_FileName            ; W: File name buffer
  221.     APTR        onm_DocBuffer            ; W: Node buffer
  222.     ULONG        onm_BuffLen            ; W: Size of buffer
  223.     ULONG        onm_Flags            ; RW: Control flags
  224.  
  225. ; onm_Flags
  226.     BITDEF HTN,KEEP,0                    ; Don't flush this node until database is closed.
  227.     BITDEF HTN,RESERVED1,1                ; Reserved for system use
  228.     BITDEF HTN,RESERVED2,2                ; Reserved for system use
  229.     BITDEF HTN,ASCII,3                    ; Node is straight ASCII
  230.     BITDEF HTN,RESERVED3,4                ; Reserved for system use
  231.     BITDEF HTN,CLEAN,5                    ; Remove the node from the database
  232.     BITDEF HTN,DONE,6                    ; Done with node
  233.  
  234. ; onm_Attrs
  235. HTNA_Screen    equ    (TAG_USER+1)            ; Screen that window resides in
  236. HTNA_Pens    equ    (TAG_USER+2)            ; Pen array (from DrawInfo)
  237. HTNA_Rectangle    equ    (TAG_USER+3)            ; Window box
  238.  
  239. ;------------------------------------------------------------------------------
  240.  
  241. ; HM_EXPUNGE
  242.     STRUCTURE opExpungeNode,0
  243.     ; ULONG        MethodID
  244.     APTR        oen_Attrs            ; R: Additional attributes
  245.  
  246. ;------------------------------------------------------------------------------
  247.  
  248.     ENDC ;* LIBRARIES_AMIGAGUIDE_I
  249.